This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

2 Complex and Simple Type Definitions. 8

The objective of this document is to depict how the Brochure Web Service messages function in OPERA Web Suite (OWS). In addition, this document breaks down the available simple and complex element types.

This document may not contain all the web service messages supported by OWS.

Audience

This document is intended for those developing custom applications that interact with Brochure functionality in OPERA via OWS operation.

Customer Support

To contact Oracle Customer Support, access My Oracle Support at the following URL:

https://support.oracle.com

When contacting Customer Support, please provide the following:

Product version and program/module name

Functional and technical description of the problem (include business impact)

Detailed step-by-step instructions to re-create

Exact error message received and any associated log files

Screen shots of each step you take

Documentation

Oracle Hospitality product documentation is available on the Oracle Help Center at http://docs.oracle.com/en/industries/hospitality/

Revision History

Date	Description of Change
September 2004	· Initial Release
September 2006	· Revised and edited
February 2007	· Edited
March 2007	· Revised
December 2007	· Replaced descriptions
March 2014	· Updated with proper example data
September 2017	· Rebrand and update document formatting
March 2022	· Updated ArrayOfText, TextList, and ResultStatus.

1 SendBrochure

Sends a brochure, given the hotel criteria, brochure type, name identifier, and email address. In order for the Brochure to send an email, Request Definition must be configured correctly in OPERA (Configuration > Profiles > Requests > Request Types).

BrochureRequest

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Header>

</OGHeader>

</soap:Header>

<soap:Body>

<c:PhoneNumber>name@example.com</c:PhoneNumber>

</Email>

</BrochureRequest>

</soap:Body>

</soap:Envelope>

BrochureRequest

<xs:complexType name="BrochureRequest">

<xs:annotation>

<xs:appinfo>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueID" />

<xs:element minOccurs="0" maxOccurs="1" name="Email" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:NamePhone" />

<xs:element minOccurs="0" maxOccurs="1" name="Property" xmlns:q3="http://webservices.micros.com/og/4.3/HotelCommon/" type="q3:HotelReference" />

<xs:element minOccurs="0" maxOccurs="1" name="BrochureType" type="xs:string" />

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
NameID	element	UniqueID	optional	The name ID of the person to whom email is sent.
Email	element	NamePhone	optional	The email address that the brochure needs to be sent to. This should be an existing email address in the Opera Reservation System (ORS). Note: In order for the Brochure to send an email, Request Definition must be configured correctly in OPERA (Configuration > Profiles > Requests > Request Types).
Property	element	HotelReference	optional	The property for which the brochure needs to be sent.
BrochureType	element	string	optional	The type of brochure to be sent.

BrochureResponse

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

<soap:Header>

</OGHeader> <wsa:Action>http://webservices.micros.com/ows/5.1/Brochure.wsdl#SendBrochureResponse</wsa:Action>

<wsa:MessageID>urn:uuid:243038c3-b5d4-427f-a511-5c278535c292</wsa:MessageID>

<wsa:RelatesTo>urn:uuid:52bc89a0-c47f-4324-8c3b-65c188603ef0</wsa:RelatesTo>

<wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

</soap:Header>

<soap:Body>

</BrochureResponse>

</soap:Body>

</soap:Envelope>

BrochureResponse

<xs:complexType name="BrochureResponse">

<xs:annotation>

<xs:appinfo>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
Result	element	ResultStatus	optional	The standard result object.

2 Complex and Simple Type Definitions

The following complex and simple types are available.

ArrayOfIDPair

<xs:complexType name="ArrayOfIDPair">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="IDPair" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:IDPair" />

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
IDPair	element	IDPair	optional / multiple	Not used in this context.

ArrayOfText

<xs:complexType name="ArrayOfText">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="TextElement" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
TextElement	element	TextList	optional / multiple	A collection of text objects.

HotelReference

<xs:complexType name="HotelReference">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="chainCode" type="xs:string" />

<xs:attribute name="hotelCode" type="xs:string" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

Name	Type	Data Type	Use	Comments
HotelReference	extension	string		Hotel reference information.
chainCode	attribute	string	none	The chain code to which the hotel belongs.
hotelCode	attribute	string	none	The hotel code.

IDPair

<xs:complexType name="IDPair">

<xs:attribute name="idType" type="xs:string" />

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

</xs:complexType>

Name	Type	Data Type	Use	Comments
idType	attribute	string	none	Not used in this context.
operaId	attribute	long	none	Not used in this context.
externalId	attribute	string	none	Not used in this context.

NamePhone

<xs:complexType name="NamePhone">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:Phone">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

Name	Type	Data Type	Use	Comments
NamePhone	extension	Phone		The phone name.
operaId	attribute	long	none	The Opera ID.
externalId	attribute	string	none	The external ID.
primary	attribute	boolean	none	An indication of whether or not this is the primary phone.
displaySequence	attribute	int	none	The order in which this phone is displayed in an ordered list.
insertUser	attribute	string	none	The insert user.
insertDate	attribute	dateTime	none	The insert date and time.
updateUser	attribute	string	none	The update user.
updateDate	attribute	dateTime	none	The update date and time.
inactiveDate	attribute	date	none	The inactive date.
NamePhone	extension	Phone		The phone name.

Phone

<xs:complexType name="Phone">

<xs:sequence>

<xs:choice minOccurs="1" maxOccurs="1">

<xs:element minOccurs="0" maxOccurs="1" name="PhoneNumber" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="PhoneData" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:PhonePhoneData" />

</xs:choice>

</xs:sequence>

<xs:attribute name="phoneType" type="xs:string" />

<xs:attribute name="phoneRole" type="xs:string" />

</xs:complexType>

Name	Type	Data Type	Use	Comments
phoneType	attribute	string	none	The phone type, such as phone, fax, etc.
phoneRole	attribute	string	none	The role of the phone, such as home, business, etc.
PhoneNumber	element	string	optional	The phone number.
PhoneData	element	PhonePhoneData	optional	Not used in this context.

PhonePhoneData

<xs:complexType name="PhonePhoneData">

<xs:attribute name="countryAccessCode" type="xs:string" />

<xs:attribute name="areaCode" type="xs:string" />

<xs:attribute name="phoneNumber" type="xs:string" />

<xs:attribute name="extension" type="xs:string" />

</xs:complexType>

Name	Type	Data Type	Use	Comments
countryAccessCode	attribute	string	none	Not used in this context.
areaCode	attribute	string	none	Not used in this context.
phoneNumber	attribute	string	none	Not used in this context.
extension	attribute	string	none	Not used in this context.

ResultStatus

<xs:complexType name="ResultStatus">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Text" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />

<xs:element minOccurs="0" maxOccurs="1" name="IDs" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2: IDPairList" />

<xs:element minOccurs="0" maxOccurs="1" name="OperaErrorCode" type="xs:string" />

</xs:sequence>

<xs:attribute name="resultStatusFlag" xmlns:q3="http://webservices.micros.com/og/4.3/Common/" type="q3:ResultStatusFlag" />

</xs:complexType>

Name	Type	Data Type	Use	Comments
resultStatusFlag	attribute	ResultStatusFlag	none	The primary indication of the success or failure of the called function.
Text	element	TextList	optional	Used to store any error or warning text associated with the transaction.
IDs	element	IDPairList	optional	If populated, this contains the ReservationID of the newly created booking.
OperaErrorCode	element	string	optional	The error code returned in the response whenever there is an error returned from the OPERA database. All error codes are defined in the default "FIDELIO" channel under the Error tab.

ResultStatusFlag

<xs:simpleType name="ResultStatusFlag">

<xs:restriction base="xs:string">

<xs:enumeration value="FAIL" />

<xs:enumeration value="SUCCESS" />

</xs:restriction>

</xs:simpleType>

Name	Type	Data Type	Use	Comments
ResultStatusFlag	enumeration	string		The possible values are FAIL and SUCCESS.

Text

<xs:complexType name="Text">

<xs:simpleContent>

<xs:extension base="xs:normalizedString">

<xs:attribute name="formatted" type="xs:boolean" />

<xs:attribute name="language" type="xs:language" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

Name	Type	Data Type	Use	Comments
Text	extension	normalizedString		Not used in this context.
formatted	attribute	boolean	none	Not used in this context.
language	attribute	language	none	Not used in this context.

TextList

<xs:complexType name="TextList">

<xs:sequence>

<xs:element name="TextElement" type="tns:Text" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

Name	Type	Data Type	Use	Comments
TextList	extension	Text		The text element.

UniqueID

<xs:complexType name="UniqueID">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="type" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueIDType" use="required" />

<xs:attribute name="source" type="xs:string" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

Name	Type	Data Type	Use	Comments
UniqueID	extension	string		The Unique ID.
type	attribute	UniqueIDType	required	The type has to be set to “INTERNAL”.
source	attribute	string	none	Not used in this context.

UniqueIDType

<xs:simpleType name="UniqueIDType">

<xs:restriction base="xs:string">

<xs:enumeration value="EXTERNAL" />

<xs:enumeration value="INTERNAL" />

<xs:enumeration value="CANCELLATIONEXTERNAL" />

<xs:enumeration value="CANCELLATIONINTERNAL" />

</xs:restriction>

</xs:simpleType>

Name	Type	Data Type	Use	Comments
UniqueIDType	enumeration	string		The possible values are EXTERNAL, INTERNAL, CANCELLATIONEXTERNAL, and CANCELLATIONINTERNAL.